Skip to content

Improve MessageFilter logging and refactor search element styles#253

Merged
tonygermano merged 2 commits intoOpenIntegrationEngine:mainfrom
tonygermano:message-filter-event
Mar 26, 2026
Merged

Improve MessageFilter logging and refactor search element styles#253
tonygermano merged 2 commits intoOpenIntegrationEngine:mainfrom
tonygermano:message-filter-event

Conversation

@tonygermano
Copy link
Copy Markdown
Member

@tonygermano tonygermano commented Feb 16, 2026

commit d19499d

Improve MessageFilter logging and refactor search element styles

Refactors the ToStringStyle implementations for MessageFilter and related
search elements to significantly improve debuggability and log readability.

Key Changes:
- Refactored MetaDataSearchElementToStringStyle into a generic
  SearchElementToStringStyle to eliminate code duplication.
- Added ContentSearchElementToStringStyle:
  - Converts raw content codes into human-readable ContentType names
    (e.g., "1(Raw)") instead of opaque integers.
- Updated MessageFilterToStringStyle:
  - Replaced legacy Calendar formatting with java.time (ZonedDateTime)
    and included time and timezone id.
  - Added recursive indentation logic to render nested collections
    in a hierarchical format.
- Applied new styles to ContentSearchElement and MetaDataSearchElement
  toString() methods.
- Previously ContentSearchElement was inheriting the Object.toString
  method.

This change primarily adds detail for ContentSearchElements when viewing
the MessageFilter in the server event log. The addition of the time and
timezone id fill in some missing details for the start and end times.
The additonal reformats improve readability.

commit 9ad3055

Add JUnit 4 tests for search element model and style classes

Added 100% test coverage for

* `ContentSearchElement`
* `MetaDataSearchElement`
* `MessageFilterToStringStyle`
* `SearchElementToStringStyle`
* `ContentSearchElementToStringStyle`

@gibson9583
Copy link
Copy Markdown
Contributor

gibson9583 commented Feb 16, 2026

can you add a screenshot of the new styling?

@tonygermano
Copy link
Copy Markdown
Member Author

tonygermano commented Feb 16, 2026

For the following search options:
image

before:

MessageFilter[
attachment=false,
contentSearch=[com.mirth.connect.model.filters.elements.ContentSearchElement@3b0e8c4, com.mirth.connect.model.filters.elements.ContentSearchElement@46b276d6],
endDate=2026-02-02,
error=false,
excludedMetaDataIds=[1],
importIdLower=6,
importIdUpper=7,
includedMetaDataIds=<null>,
maxMessageId=6,
metaDataSearch=[
MetaDataSearchElement[columnName=SOURCE,ignoreCase=true,operator=CONTAINS,value=XYZ],
MetaDataSearchElement[columnName=TYPE,ignoreCase=false,operator=EQUAL,value=FOO]
],
minMessageId=5,
originalIdLower=1,
originalIdUpper=2,
sendAttemptsLower=1,
sendAttemptsUpper=5,
serverId=792e3c00-6906-4444-9642-02603403335e,
startDate=2026-02-01,
statuses=[RECEIVED, SENT, TRANSFORMED, QUEUED],
textSearch=M0000123,
textSearchMetaDataColumns=[SOURCE, TYPE],
textSearchRegex=<null>
]

after:

MessageFilter[
  attachment=false,
  contentSearch=[
    ContentSearchElement[contentCode=1(Raw), searches=["raw 1", "raw 2"]],
    ContentSearchElement[contentCode=5(Sent), searches=["sent 1"]]
  ],
  endDate=2026-02-02 17:16-05:00[America/New_York],
  error=false,
  excludedMetaDataIds=[1],
  importIdLower=6,
  importIdUpper=7,
  includedMetaDataIds=<null>,
  maxMessageId=6,
  metaDataSearch=[
    MetaDataSearchElement[columnName="SOURCE",ignoreCase=true,operator="CONTAINS",value="XYZ"],
    MetaDataSearchElement[columnName="TYPE",ignoreCase=false,operator="EQUAL",value="FOO"]
  ],
  minMessageId=5,
  originalIdLower=1,
  originalIdUpper=2,
  sendAttemptsLower=1,
  sendAttemptsUpper=5,
  serverId=792e3c00-6906-4444-9642-02603403335e,
  startDate=2026-02-01 08:01-05:00[America/New_York],
  statuses=[TRANSFORMED, QUEUED, SENT, RECEIVED],
  textSearch=M0000123,
  textSearchMetaDataColumns=[SOURCE, TYPE],
  textSearchRegex=<null>
]

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 16, 2026 •
edited
Loading

Test Results

  110 files  + 5    212 suites  +10   6m 57s ⏱️ + 1m 9s
  650 tests +17    650 ✅ +17  0 💤 ±0  0 ❌ ±0 
1 300 runs  +34  1 300 ✅ +34  0 💤 ±0  0 ❌ ±0 

Results for commit bfe3348. ± Comparison against base commit 346cc45.

♻️ This comment has been updated with latest results.

@tonygermano tonygermano requested review from a team, NicoPiel, gibson9583, jonbartels, kayyagari, kpalang, mgaffigan and ssrowe and removed request for a team February 16, 2026 17:52
gibson9583
gibson9583 previously approved these changes Feb 16, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@gibson9583 gibson9583 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good again. appreciate the well documented PR

kayyagari
kayyagari previously approved these changes Feb 17, 2026
View reviewed changes
jonbartels
jonbartels previously approved these changes Feb 19, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@jonbartels jonbartels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good improvement. It should be specifically called out in the release notes since someone could be doing something obscure parsing this data via an API call. I would not consider that likely.

Presenting this as a UI/UX improvement with a note that API usages may be affected would be ideal.

@tonygermano tonygermano dismissed stale reviews from jonbartels, kayyagari, and gibson9583 via 2e9d422 March 16, 2026 05:21
@tonygermano tonygermano force-pushed the message-filter-event branch from 9ad3055 to 2e9d422 Compare March 16, 2026 05:21
@tonygermano
Copy link
Copy Markdown
Member Author

tonygermano commented Mar 16, 2026

Please see the latest commit's message for details. With the changes, the output now looks like this.

MessageFilter[
  attachment=false,
  contentSearch=[
    ContentSearchElement[contentCode=1(Raw), searches=[raw 1, raw 2]],
    ContentSearchElement[contentCode=5(Sent), searches=[sent 1]]
  ],
  endDate=2026-02-02 17:16-05:00[America/New_York],
  error=false,
  excludedMetaDataIds=[1],
  importIdLower=6,
  importIdUpper=7,
  includedMetaDataIds=<null>,
  maxMessageId=6,
  metaDataSearch=[
    MetaDataSearchElement[columnName=SOURCE, ignoreCase=true, operator=CONTAINS, value=XYZ],
    MetaDataSearchElement[columnName=TYPE, ignoreCase=false, operator=EQUAL, value=FOO]
  ],
  minMessageId=5,
  originalIdLower=1,
  originalIdUpper=2,
  sendAttemptsLower=1,
  sendAttemptsUpper=5,
  serverId=792e3c00-6906-4444-9642-02603403335e,
  startDate=2026-02-01 08:01-05:00[America/New_York],
  statuses=[SENT, QUEUED, TRANSFORMED, RECEIVED],
  textSearch=M0000123,
  textSearchMetaDataColumns=[SOURCE, TYPE],
  textSearchRegex=<null>
]

@tonygermano
Improve MessageFilter logging and refactor search element styles
7311e1b 
Refactors the ToStringStyle implementations for MessageFilter and related
search elements to significantly improve debuggability and log readability.

Key Changes:
- Refactored MetaDataSearchElementToStringStyle into a generic
  SearchElementToStringStyle to eliminate code duplication.
- Added ContentSearchElementToStringStyle:
  - Converts raw content codes into human-readable ContentType names
    (e.g., "1(Raw)") instead of opaque integers.
- Updated MessageFilterToStringStyle:
  - Replaced legacy Calendar formatting with java.time (ZonedDateTime)
    and included time and timezone id.
  - Added recursive indentation logic to render nested collections
    in a hierarchical format.
- Applied new styles to ContentSearchElement and MetaDataSearchElement
  toString() methods.
- Previously ContentSearchElement was inheriting the Object.toString
  method.

This change primarily adds detail for ContentSearchElements when viewing
the MessageFilter in the server event log. The addition of the time and
timezone id fill in some missing details for the start and end times.
The additonal reformats improve readability.

Signed-off-by: Tony Germano <tony@germano.name>
@tonygermano
Add JUnit 4 tests for search element model and style classes
bfe3348 
Added 100% test coverage for

* `ContentSearchElement`
* `MetaDataSearchElement`
* `MessageFilterToStringStyle`
* `SearchElementToStringStyle`
* `ContentSearchElementToStringStyle`

Signed-off-by: Tony Germano <tony@germano.name>
@tonygermano tonygermano force-pushed the message-filter-event branch from 2e9d422 to bfe3348 Compare March 26, 2026 18:07
@tonygermano tonygermano added this to the 4.6.0 milestone Mar 26, 2026
@tonygermano tonygermano merged commit bfe3348 into OpenIntegrationEngine:main Mar 26, 2026
4 checks passed
@tonygermano tonygermano deleted the message-filter-event branch March 26, 2026 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kayyagari kayyagari kayyagari approved these changes

@gibson9583 gibson9583 gibson9583 approved these changes

@jonbartels jonbartels jonbartels approved these changes

@mgaffigan mgaffigan mgaffigan approved these changes

@ssrowe ssrowe Awaiting requested review from ssrowe ssrowe was automatically assigned from OpenIntegrationEngine/maintainers

@kpalang kpalang Awaiting requested review from kpalang kpalang was automatically assigned from OpenIntegrationEngine/maintainers

@NicoPiel NicoPiel Awaiting requested review from NicoPiel NicoPiel was automatically assigned from OpenIntegrationEngine/maintainers

+1 more reviewer

@kryskool kryskool kryskool approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

4.6.0

Development

Successfully merging this pull request may close these issues.

6 participants

@tonygermano @gibson9583 @kayyagari @kryskool @jonbartels @mgaffigan